.. _cmmStGetMstString:

cmmStGetMstString
========================
------------------------

SYNOPSIS
```````````

.. code-block:: none

    VT_I4 cmmStGetMstString(
        [in] VT_I4 MstCode, [out] VT_STR Buffer, 
        [in] VT_I4 BufferLen
        )

     
DESCRIPTION
```````````````

- 이 함수는 현재 모션 동작 상태(動作狀態 )와 관련된 문자열을 반환합니다. CMMSDK 의 모션 동작 상태를 확인(確認) 
  하는 cmmStReadMotionState() 함수를 통해 반환된 모션 동작 상태 값을 매개 변수로 전달하게 되면, 해당 상태에 대한
  이미 내정된 문자열을 지정된 문자열 주소에 복사합니다. 이 문자열은 라이브러리 내부에서 이미 결정된 문자열
  이므로, 사용자 정의 에러 메시지와는 무관합니다.


PARAMETER
```````````

- MstCode : 모션 동작 상태와 관련된 값입니다. cmmStReadMotionState() 함수를 통해 지정된 상태 값을 알아볼 수
  있으며, 해당 상태 값을 이 함수의 매개변수로 활용할 수 있습니다.

\

- Buffer : 모션 동작 상태와 관련된 문자열을 복사해올 문자열 버퍼의 주소입니다.

\

- BufferLen : 모션 동작 상태를 확인(確認)하기 위해 전달된 문자열 버퍼의 길이입니다. 이 길이가 실제 복사될 모션
  동작 상태보다 작으면, 실제 전달된 문자열 버퍼의 길이만큼 상태에 대한 문자열을 복사합니다.


RETURN VALUE
`````````````
.. csv-table::
  :widths: 10 85
  :header-rows: 1
  :stub-columns: 0

  Value, Meaning
  음수, 수행 실패
  cmERR_NONE, 수행 성공


REFERENCE
```````````

- 논리적 거리 단위는 cmmCfgSetUnitDist() 함수에 의해 결정됩니다.

EXAMPLE
```````````

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5


 C/C++

 #include “Cmmsdk.h”
 #include “CmmsdkDef.h”

 void OnGetMstString ()
 {
 char szBuffer[32] = {0, };

 // 현재 Motion State 를 Buffer 에 문자열로 저장합니다.
 if ( cmmStGetMstString (cmX1, szBuffer, 32 ) == cmERR_NONE )
    {
        //DisplayMstString() 함수는 화면에 문자를 표시하는 가상의 함수입니다.
        DisplayMstString( szBuffer );
    }
 }